Skip to content

Comments

Add documentation for custom class serialization#810

Draft
TooTallNate wants to merge 3 commits intomainfrom
01-19-add_documentation_for_custom_class_serialization
Draft

Add documentation for custom class serialization#810
TooTallNate wants to merge 3 commits intomainfrom
01-19-add_documentation_for_custom_class_serialization

Conversation

@TooTallNate
Copy link
Member

@TooTallNate TooTallNate commented Jan 19, 2026 •
edited
Loading

NOTE: Keeping as a draft for now so we don't document this feature publicly until it's been :dogfood: internally.

Added documentation for custom class serialization in workflows with new @workflow/serde package.

What changed?

  • Added documentation for the new @workflow/serde package that provides serialization symbols for custom class serialization
  • Added a new section to the serialization docs explaining how to make custom classes serializable
  • Added the @workflow/serde package to the API reference navigation
  • Updated the docs-typecheck extractor to support MDX comments for expect-error annotations

Why make this change?

Custom class serialization is an important feature for workflows that need to work with complex data structures. This documentation explains how developers can make their own classes serializable using the WORKFLOW_SERIALIZE and WORKFLOW_DESERIALIZE symbols from the new @workflow/serde package, enabling seamless passing of class instances between workflow and step functions.

@changeset-bot
Copy link

changeset-bot bot commented Jan 19, 2026 •
edited
Loading

🦋 Changeset detected

Latest commit: 199d665

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions
Copy link
Contributor

github-actions bot commented Jan 19, 2026 •
edited
Loading

🧪 E2E Test Results

❌ Some tests failed

Summary

Passed Failed Skipped Total
❌ ▲ Vercel Production 522 1 49 572
✅ 💻 Local Development 556 0 68 624
✅ 📦 Local Production 556 0 68 624
✅ 🐘 Local Postgres 556 0 68 624
✅ 🪟 Windows 49 0 3 52
❌ 🌍 Community Worlds 111 45 9 165
✅ 📋 Other 135 0 21 156
Total 2485 46 286 2817

❌ Failed Tests

▲ Vercel Production (1 failed)

express (1 failed):

  • webhookWorkflow
🌍 Community Worlds (45 failed)

turso (45 failed):

  • addTenWorkflow
  • addTenWorkflow
  • should work with react rendering in step
  • promiseAllWorkflow
  • promiseRaceWorkflow
  • promiseAnyWorkflow
  • hookWorkflow
  • webhookWorkflow
  • sleepingWorkflow
  • parallelSleepWorkflow
  • nullByteWorkflow
  • workflowAndStepMetadataWorkflow
  • fetchWorkflow
  • promiseRaceStressTestWorkflow
  • error handling error propagation workflow errors nested function calls preserve message and stack trace
  • error handling error propagation workflow errors cross-file imports preserve message and stack trace
  • error handling error propagation step errors basic step error preserves message and stack trace
  • error handling error propagation step errors cross-file step error preserves message and function names in stack
  • error handling retry behavior regular Error retries until success
  • error handling retry behavior FatalError fails immediately without retries
  • error handling retry behavior RetryableError respects custom retryAfter delay
  • error handling retry behavior maxRetries=0 disables retries
  • error handling retry behavior workflow completes despite transient 5xx on step_completed
  • error handling catchability FatalError can be caught and detected with FatalError.is()
  • hookCleanupTestWorkflow - hook token reuse after workflow completion
  • concurrent hook token conflict - two workflows cannot use the same hook token simultaneously
  • stepFunctionPassingWorkflow - step function references can be passed as arguments (without closure vars)
  • stepFunctionWithClosureWorkflow - step function with closure variables passed as argument
  • closureVariableWorkflow - nested step functions with closure variables
  • spawnWorkflowFromStepWorkflow - spawning a child workflow using start() inside a step
  • health check (queue-based) - workflow and step endpoints respond to health check messages
  • pathsAliasWorkflow - TypeScript path aliases resolve correctly
  • Calculator.calculate - static workflow method using static step methods from another class
  • AllInOneService.processNumber - static workflow method using sibling static step methods
  • ChainableService.processWithThis - static step methods using this to reference the class
  • thisSerializationWorkflow - step function invoked with .call() and .apply()
  • customSerializationWorkflow - custom class serialization with WORKFLOW_SERIALIZE/WORKFLOW_DESERIALIZE
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • stepFunctionAsStartArgWorkflow - step function reference passed as start() argument
  • cancelRun - cancelling a running workflow
  • cancelRun via CLI - cancelling a running workflow
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router

Details by Category

❌ ▲ Vercel Production
App Passed Failed Skipped
✅ astro 47 0 5
✅ example 47 0 5
❌ express 46 1 5
✅ fastify 47 0 5
✅ hono 47 0 5
✅ nextjs-turbopack 50 0 2
✅ nextjs-webpack 50 0 2
✅ nitro 47 0 5
✅ nuxt 47 0 5
✅ sveltekit 47 0 5
✅ vite 47 0 5
✅ 💻 Local Development
App Passed Failed Skipped
✅ astro-stable 45 0 7
✅ express-stable 45 0 7
✅ fastify-stable 45 0 7
✅ hono-stable 45 0 7
✅ nextjs-turbopack-canary 49 0 3
✅ nextjs-turbopack-stable 49 0 3
✅ nextjs-webpack-canary 49 0 3
✅ nextjs-webpack-stable 49 0 3
✅ nitro-stable 45 0 7
✅ nuxt-stable 45 0 7
✅ sveltekit-stable 45 0 7
✅ vite-stable 45 0 7
✅ 📦 Local Production
App Passed Failed Skipped
✅ astro-stable 45 0 7
✅ express-stable 45 0 7
✅ fastify-stable 45 0 7
✅ hono-stable 45 0 7
✅ nextjs-turbopack-canary 49 0 3
✅ nextjs-turbopack-stable 49 0 3
✅ nextjs-webpack-canary 49 0 3
✅ nextjs-webpack-stable 49 0 3
✅ nitro-stable 45 0 7
✅ nuxt-stable 45 0 7
✅ sveltekit-stable 45 0 7
✅ vite-stable 45 0 7
✅ 🐘 Local Postgres
App Passed Failed Skipped
✅ astro-stable 45 0 7
✅ express-stable 45 0 7
✅ fastify-stable 45 0 7
✅ hono-stable 45 0 7
✅ nextjs-turbopack-canary 49 0 3
✅ nextjs-turbopack-stable 49 0 3
✅ nextjs-webpack-canary 49 0 3
✅ nextjs-webpack-stable 49 0 3
✅ nitro-stable 45 0 7
✅ nuxt-stable 45 0 7
✅ sveltekit-stable 45 0 7
✅ vite-stable 45 0 7
✅ 🪟 Windows
App Passed Failed Skipped
✅ nextjs-turbopack 49 0 3
❌ 🌍 Community Worlds
App Passed Failed Skipped
✅ mongodb-dev 3 0 0
✅ mongodb 49 0 3
✅ redis-dev 3 0 0
✅ redis 49 0 3
✅ turso-dev 3 0 0
❌ turso 4 45 3
✅ 📋 Other
App Passed Failed Skipped
✅ e2e-local-dev-nest-stable 45 0 7
✅ e2e-local-postgres-nest-stable 45 0 7
✅ e2e-local-prod-nest-stable 45 0 7

📋 View full workflow run

❌ Some E2E test jobs failed:

  • Vercel Prod: failure
  • Local Dev: success
  • Local Prod: success
  • Local Postgres: success
  • Windows: success

Check the workflow run for details.

This was referenced Jan 19, 2026
Merged
Merged
Merged
@TooTallNate Graphite App
Copy link
Member Author

TooTallNate commented Jan 19, 2026 •
edited
Loading

This stack of pull requests is managed by Graphite. Learn more about stacking.

This was referenced Jan 19, 2026
Merged
Merged
@TooTallNate TooTallNate marked this pull request as ready for review January 19, 2026 23:18
Copilot AI review requested due to automatic review settings January 19, 2026 23:18
@TooTallNate TooTallNate marked this pull request as draft January 19, 2026 23:18
@vercel
Copy link
Contributor

vercel bot commented Jan 19, 2026 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
example-nextjs-workflow-turbopack Ready Ready Preview, Comment, Open in v0 Feb 20, 2026 8:26pm
example-nextjs-workflow-webpack Ready Ready Preview, Comment, Open in v0 Feb 20, 2026 8:26pm
example-workflow Ready Ready Preview, Comment, Open in v0 Feb 20, 2026 8:26pm
workbench-astro-workflow Ready Ready Preview, Comment, Open in v0 Feb 20, 2026 8:26pm
workbench-express-workflow Ready Ready Preview, Comment, Open in v0 Feb 20, 2026 8:26pm
workbench-fastify-workflow Ready Ready Preview, Comment, Open in v0 Feb 20, 2026 8:26pm
workbench-hono-workflow Ready Ready Preview, Comment, Open in v0 Feb 20, 2026 8:26pm
workbench-nitro-workflow Ready Ready Preview, Comment, Open in v0 Feb 20, 2026 8:26pm
workbench-nuxt-workflow Ready Ready Preview, Comment, Open in v0 Feb 20, 2026 8:26pm
workbench-sveltekit-workflow Ready Ready Preview, Comment, Open in v0 Feb 20, 2026 8:26pm
workbench-vite-workflow Ready Ready Preview, Comment, Open in v0 Feb 20, 2026 8:26pm
workflow-docs Ready Ready Preview, Comment, Open in v0 Feb 20, 2026 8:26pm
workflow-nest Ready Ready Preview, Comment, Open in v0 Feb 20, 2026 8:26pm
workflow-swc-playground Ready Ready Preview, Comment, Open in v0 Feb 20, 2026 8:26pm

@TooTallNate TooTallNate force-pushed the 01-19-add_documentation_for_custom_class_serialization branch from cbe3550 to 9020264 Compare January 19, 2026 23:19
Copilot AI reviewed Jan 19, 2026
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds comprehensive documentation for the custom class serialization feature using the new @workflow/serde package. The documentation explains how developers can make their custom classes serializable in workflows by implementing WORKFLOW_SERIALIZE and WORKFLOW_DESERIALIZE symbols.

Changes:

  • Added a new "Custom Class Serialization" section to the serialization documentation with examples showing basic and complex usage patterns
  • Updated the docs-typecheck extractor to support MDX-style comments for @expect-error annotations in addition to HTML comments
  • Added the @workflow/serde package to the API reference navigation and index

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.

Show a summary per file
File Description
packages/docs-typecheck/src/extractor.ts Enhanced regex to support both HTML and MDX comment formats for @expect-error annotations
docs/content/docs/foundations/serialization.mdx Added comprehensive documentation section explaining custom class serialization with code examples
docs/content/docs/api-reference/meta.json Added workflow-serde to the API reference pages list
docs/content/docs/api-reference/index.mdx Added Card component linking to the @workflow/serde package documentation
.changeset/smooth-nails-do.md Empty changeset file (acceptable for documentation-only changes)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@TooTallNate TooTallNate force-pushed the 01-19-add_documentation_for_custom_class_serialization branch from 841ddee to 4241b40 Compare January 19, 2026 23:40
@github-actions
Copy link
Contributor

github-actions bot commented Jan 19, 2026 •
edited
Loading

📊 Benchmark Results

📈 Comparing against baseline from main branch. Green 🟢 = faster, Red 🔺 = slower.

workflow with no steps

💻 Local Development

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
💻 Local 🥇 Express 0.032s (-1.2%) 1.005s (~) 0.973s 10 1.00x
💻 Local Nitro 0.032s (+1.9%) 1.005s (~) 0.973s 10 1.02x
🐘 Postgres Nitro 0.127s (-13.5% 🟢) 1.010s (~) 0.882s 10 4.00x
🐘 Postgres Express 0.199s (+40.2% 🔺) 1.009s (~) 0.810s 10 6.25x
💻 Local Next.js (Turbopack) ⚠️ missing - - - -
🐘 Postgres Next.js (Turbopack) ⚠️ missing - - - -

▲ Production (Vercel)

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Express 0.478s (-8.8% 🟢) 1.784s (-19.2% 🟢) 1.306s 10 1.00x
▲ Vercel Nitro 0.494s (-19.1% 🟢) 1.822s (-13.2% 🟢) 1.328s 10 1.03x
▲ Vercel Next.js (Turbopack) 0.561s (-10.7% 🟢) 1.830s (-6.5% 🟢) 1.269s 10 1.17x

🔍 Observability: Express | Nitro | Next.js (Turbopack)

workflow with 1 step

💻 Local Development

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
💻 Local 🥇 Nitro 1.106s (~) 2.006s (~) 0.900s 10 1.00x
💻 Local Express 1.109s (~) 2.006s (~) 0.896s 10 1.00x
🐘 Postgres Express 2.140s (-9.5% 🟢) 3.013s (~) 0.874s 10 1.93x
🐘 Postgres Nitro 2.410s (+3.8%) 3.013s (~) 0.603s 10 2.18x
💻 Local Next.js (Turbopack) ⚠️ missing - - - -
🐘 Postgres Next.js (Turbopack) ⚠️ missing - - - -

▲ Production (Vercel)

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Nitro 2.023s (-58.4% 🟢) 3.373s (-46.2% 🟢) 1.351s 10 1.00x
▲ Vercel Next.js (Turbopack) 2.077s (-2.9%) 2.961s (-13.7% 🟢) 0.884s 10 1.03x
▲ Vercel Express 2.416s (-34.4% 🟢) 3.466s (-30.7% 🟢) 1.049s 10 1.19x

🔍 Observability: Nitro | Next.js (Turbopack) | Express

workflow with 10 sequential steps

💻 Local Development

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
💻 Local 🥇 Express 10.823s (~) 11.023s (~) 0.200s 3 1.00x
💻 Local Nitro 10.835s (~) 11.022s (~) 0.188s 3 1.00x
🐘 Postgres Nitro 20.398s (~) 21.053s (~) 0.655s 2 1.88x
🐘 Postgres Express 20.461s (~) 21.053s (~) 0.592s 2 1.89x
💻 Local Next.js (Turbopack) ⚠️ missing - - - -
🐘 Postgres Next.js (Turbopack) ⚠️ missing - - - -

▲ Production (Vercel)

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Next.js (Turbopack) 16.111s (~) 16.776s (-2.6%) 0.664s 2 1.00x
▲ Vercel Express 16.260s (-0.7%) 17.097s (-3.0%) 0.837s 2 1.01x
▲ Vercel Nitro 18.078s (+8.5% 🔺) 19.541s (+7.2% 🔺) 1.463s 2 1.12x

🔍 Observability: Next.js (Turbopack) | Express | Nitro

workflow with 25 sequential steps

💻 Local Development

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
💻 Local 🥇 Express 27.464s (~) 28.052s (~) 0.588s 3 1.00x
💻 Local Nitro 27.509s (~) 28.052s (~) 0.543s 3 1.00x
🐘 Postgres Express 50.226s (~) 51.119s (~) 0.893s 2 1.83x
🐘 Postgres Nitro 50.255s (+13.2% 🔺) 51.128s (+13.4% 🔺) 0.872s 2 1.83x
💻 Local Next.js (Turbopack) ⚠️ missing - - - -
🐘 Postgres Next.js (Turbopack) ⚠️ missing - - - -

▲ Production (Vercel)

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Express 40.601s (-6.0% 🟢) 41.622s (-6.4% 🟢) 1.021s 2 1.00x
▲ Vercel Nitro 40.656s (-3.6%) 41.797s (-3.8%) 1.141s 2 1.00x
▲ Vercel Next.js (Turbopack) 74.348s (+78.4% 🔺) 75.772s (+76.0% 🔺) 1.424s 1 1.83x

🔍 Observability: Express | Nitro | Next.js (Turbopack)

workflow with 50 sequential steps

💻 Local Development

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
💻 Local 🥇 Nitro 57.182s (~) 58.103s (+1.8%) 0.920s 2 1.00x
💻 Local Express 57.245s (~) 58.101s (~) 0.856s 2 1.00x
🐘 Postgres Express 81.557s (-18.7% 🟢) 82.180s (-18.8% 🟢) 0.623s 2 1.43x
🐘 Postgres Nitro 100.486s (+23.6% 🔺) 101.229s (+23.9% 🔺) 0.743s 1 1.76x
💻 Local Next.js (Turbopack) ⚠️ missing - - - -
🐘 Postgres Next.js (Turbopack) ⚠️ missing - - - -

▲ Production (Vercel)

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Nitro 82.567s (-6.0% 🟢) 83.779s (-6.0% 🟢) 1.212s 2 1.00x
▲ Vercel Next.js (Turbopack) 83.910s (-1.5%) 84.908s (-1.3%) 0.998s 2 1.02x
▲ Vercel Express 84.648s (+1.4%) 85.581s (+0.7%) 0.933s 2 1.03x

🔍 Observability: Nitro | Next.js (Turbopack) | Express

Promise.all with 10 concurrent steps

💻 Local Development

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
💻 Local 🥇 Express 1.405s (~) 2.005s (~) 0.600s 15 1.00x
💻 Local Nitro 1.413s (+1.5%) 2.005s (~) 0.592s 15 1.01x
🐘 Postgres Express 2.116s (-11.3% 🟢) 2.595s (-13.9% 🟢) 0.479s 12 1.51x
🐘 Postgres Nitro 2.589s (+23.2% 🔺) 3.015s (+16.2% 🔺) 0.426s 10 1.84x
💻 Local Next.js (Turbopack) ⚠️ missing - - - -
🐘 Postgres Next.js (Turbopack) ⚠️ missing - - - -

▲ Production (Vercel)

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Next.js (Turbopack) 2.187s (-46.8% 🟢) 3.070s (-43.9% 🟢) 0.882s 10 1.00x
▲ Vercel Nitro 2.308s (-14.5% 🟢) 3.554s (-19.7% 🟢) 1.246s 9 1.06x
▲ Vercel Express 2.338s (-43.3% 🟢) 3.336s (-40.3% 🟢) 0.998s 9 1.07x

🔍 Observability: Next.js (Turbopack) | Nitro | Express

Promise.all with 25 concurrent steps

💻 Local Development

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
💻 Local 🥇 Express 2.553s (~) 3.007s (~) 0.455s 10 1.00x
💻 Local Nitro 2.559s (+3.0%) 3.007s (~) 0.447s 10 1.00x
🐘 Postgres Nitro 8.456s (-9.2% 🟢) 9.028s (-7.7% 🟢) 0.572s 4 3.31x
🐘 Postgres Express 9.382s (+7.1% 🔺) 9.779s (+5.4% 🔺) 0.397s 4 3.68x
💻 Local Next.js (Turbopack) ⚠️ missing - - - -
🐘 Postgres Next.js (Turbopack) ⚠️ missing - - - -

▲ Production (Vercel)

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Express 2.506s (~) 3.189s (-12.7% 🟢) 0.682s 10 1.00x
▲ Vercel Nitro 2.525s (-5.8% 🟢) 3.537s (-7.7% 🟢) 1.012s 9 1.01x
▲ Vercel Next.js (Turbopack) 3.031s (+6.6% 🔺) 3.842s (-15.9% 🟢) 0.811s 8 1.21x

🔍 Observability: Express | Nitro | Next.js (Turbopack)

Promise.all with 50 concurrent steps

💻 Local Development

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
💻 Local 🥇 Express 7.095s (-1.2%) 7.764s (-3.2%) 0.669s 4 1.00x
💻 Local Nitro 7.266s (+4.6%) 8.024s (+11.1% 🔺) 0.758s 4 1.02x
🐘 Postgres Express 47.110s (~) 48.103s (~) 0.993s 1 6.64x
🐘 Postgres Nitro 49.274s (-5.1% 🟢) 50.128s (-3.8%) 0.854s 1 6.94x
💻 Local Next.js (Turbopack) ⚠️ missing - - - -
🐘 Postgres Next.js (Turbopack) ⚠️ missing - - - -

▲ Production (Vercel)

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Express 2.816s (-21.2% 🟢) 4.309s (-7.2% 🟢) 1.492s 7 1.00x
▲ Vercel Next.js (Turbopack) 3.074s (+4.2%) 3.980s (~) 0.907s 8 1.09x
▲ Vercel Nitro 3.376s (+13.1% 🔺) 4.424s (+6.3% 🔺) 1.048s 7 1.20x

🔍 Observability: Express | Next.js (Turbopack) | Nitro

Promise.race with 10 concurrent steps

💻 Local Development

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
💻 Local 🥇 Express 1.419s (+0.9%) 2.005s (~) 0.585s 15 1.00x
💻 Local Nitro 1.450s (+2.2%) 2.005s (~) 0.555s 15 1.02x
🐘 Postgres Nitro 2.004s (-7.3% 🟢) 2.514s (~) 0.509s 12 1.41x
🐘 Postgres Express 2.192s (+6.0% 🔺) 2.594s (~) 0.402s 12 1.54x
💻 Local Next.js (Turbopack) ⚠️ missing - - - -
🐘 Postgres Next.js (Turbopack) ⚠️ missing - - - -

▲ Production (Vercel)

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Next.js (Turbopack) 2.092s (-1.9%) 2.946s (-14.8% 🟢) 0.853s 11 1.00x
▲ Vercel Nitro 2.151s (-21.3% 🟢) 3.463s (-12.6% 🟢) 1.312s 9 1.03x
▲ Vercel Express 2.291s (-12.5% 🟢) 3.197s (-20.3% 🟢) 0.906s 10 1.10x

🔍 Observability: Next.js (Turbopack) | Nitro | Express

Promise.race with 25 concurrent steps

💻 Local Development

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
💻 Local 🥇 Nitro 2.635s (+1.3%) 3.008s (~) 0.373s 10 1.00x
💻 Local Express 2.682s (~) 3.008s (~) 0.326s 10 1.02x
🐘 Postgres Nitro 11.133s (+5.8% 🔺) 11.704s (+6.1% 🔺) 0.571s 3 4.22x
🐘 Postgres Express 12.513s (+2.3%) 13.033s (~) 0.520s 3 4.75x
💻 Local Next.js (Turbopack) ⚠️ missing - - - -
🐘 Postgres Next.js (Turbopack) ⚠️ missing - - - -

▲ Production (Vercel)

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Nitro 2.210s (-13.0% 🟢) 3.378s (-11.2% 🟢) 1.168s 9 1.00x
▲ Vercel Express 2.399s (+8.1% 🔺) 3.237s (-6.7% 🟢) 0.838s 10 1.09x
▲ Vercel Next.js (Turbopack) 2.421s (-5.1% 🟢) 3.178s (-12.1% 🟢) 0.756s 10 1.10x

🔍 Observability: Nitro | Express | Next.js (Turbopack)

Promise.race with 50 concurrent steps

💻 Local Development

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
💻 Local 🥇 Nitro 7.665s (+2.0%) 8.020s (~) 0.354s 4 1.00x
💻 Local Express 8.058s (+1.0%) 8.770s (~) 0.712s 4 1.05x
🐘 Postgres Nitro 53.663s (+1.2%) 54.122s (+1.9%) 0.459s 1 7.00x
🐘 Postgres Express 55.388s (+5.3% 🔺) 56.106s (+5.6% 🔺) 0.718s 1 7.23x
💻 Local Next.js (Turbopack) ⚠️ missing - - - -
🐘 Postgres Next.js (Turbopack) ⚠️ missing - - - -

▲ Production (Vercel)

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Express 2.394s (-25.7% 🟢) 3.108s (-28.9% 🟢) 0.714s 10 1.00x
▲ Vercel Next.js (Turbopack) 2.880s (-25.4% 🟢) 3.756s (-26.9% 🟢) 0.877s 8 1.20x
▲ Vercel Nitro 3.342s (-18.7% 🟢) 4.340s (-20.9% 🟢) 0.998s 7 1.40x

🔍 Observability: Express | Next.js (Turbopack) | Nitro

Stream Benchmarks (includes TTFB metrics)
workflow with stream

💻 Local Development

World Framework Workflow Time TTFB Slurp Wall Time Overhead Samples vs Fastest
💻 Local 🥇 Nitro 0.171s (-0.6%) 1.002s (~) 0.010s (-1.9%) 1.016s (~) 0.845s 10 1.00x
💻 Local Express 0.172s (+2.3%) 1.002s (~) 0.011s (-3.7%) 1.016s (~) 0.843s 10 1.01x
🐘 Postgres Express 1.377s (-43.7% 🟢) 1.656s (-36.2% 🟢) 0.001s (-21.4% 🟢) 2.012s (-33.2% 🟢) 0.635s 10 8.06x
🐘 Postgres Nitro 2.114s (+60.9% 🔺) 2.930s (+84.8% 🔺) 0.001s (-13.3% 🟢) 3.014s (+57.7% 🔺) 0.900s 10 12.38x
💻 Local Next.js (Turbopack) ⚠️ missing - - - - -
🐘 Postgres Next.js (Turbopack) ⚠️ missing - - - - -

▲ Production (Vercel)

World Framework Workflow Time TTFB Slurp Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Next.js (Turbopack) 1.578s (-23.6% 🟢) 2.220s (-18.0% 🟢) 0.156s (+27.9% 🔺) 2.772s (-23.9% 🟢) 1.194s 10 1.00x
▲ Vercel Express 1.612s (-17.1% 🟢) 2.433s (-6.0% 🟢) 0.150s (-67.7% 🟢) 3.042s (-16.7% 🟢) 1.430s 10 1.02x
▲ Vercel Nitro 1.656s (-15.5% 🟢) 2.195s (-8.9% 🟢) 0.345s (-64.9% 🟢) 3.028s (-22.9% 🟢) 1.372s 10 1.05x

🔍 Observability: Next.js (Turbopack) | Express | Nitro

Summary

Fastest Framework by World

Winner determined by most benchmark wins

World 🥇 Fastest Framework Wins
💻 Local Express 7/12
🐘 Postgres Nitro 6/12
▲ Vercel Express 5/12
Fastest World by Framework

Winner determined by most benchmark wins

Framework 🥇 Fastest World Wins
Express 💻 Local 8/12
Next.js (Turbopack) ▲ Vercel 12/12
Nitro 💻 Local 8/12
Column Definitions
  • Workflow Time: Runtime reported by workflow (completedAt - createdAt) - primary metric
  • TTFB: Time to First Byte - time from workflow start until first stream byte received (stream benchmarks only)
  • Slurp: Time from first byte to complete stream consumption (stream benchmarks only)
  • Wall Time: Total testbench time (trigger workflow + poll for result)
  • Overhead: Testbench overhead (Wall Time - Workflow Time)
  • Samples: Number of benchmark iterations run
  • vs Fastest: How much slower compared to the fastest configuration for this benchmark

Worlds:

  • 💻 Local: In-memory filesystem world (local development)
  • 🐘 Postgres: PostgreSQL database world (local development)
  • ▲ Vercel: Vercel production/preview deployment
  • 🌐 Turso: Community world (local development)
  • 🌐 MongoDB: Community world (local development)
  • 🌐 Redis: Community world (local development)
  • 🌐 Jazz: Community world (local development)

📋 View full workflow run

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@TooTallNate